Skip to content

Applications: nrf5340_audio: Removed uart terminal #22660

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

koffes
Copy link
Contributor

@koffes koffes commented Jun 5, 2025

OCT-3390
UART terminal tool removed.
Similar functionality is provided via Serial Terminal in VS Code

@koffes koffes requested review from a team as code owners June 5, 2025 11:25
@koffes koffes requested review from rick1082, alexsven and gWacey June 5, 2025 11:25
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Jun 5, 2025
@koffes koffes force-pushed the OCT-3390-remove-uart-terminal-from-ncs branch from 49c7122 to 52278ce Compare June 5, 2025 11:27
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jun 5, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 7

Inputs:

Sources:

sdk-nrf: PR head: 2d88f5a2a89ee6d0ced14d7e56d8b217173f4af9

more details

sdk-nrf:

PR head: 2d88f5a2a89ee6d0ced14d7e56d8b217173f4af9
merge base: e39855b1d4494e4cd9b16a2b39110f4c701d10b4
target head (main): e39855b1d4494e4cd9b16a2b39110f4c701d10b4
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (6)
applications
│  ├── nrf5340_audio
│  │  ├── tools
│  │  │  ├── uart_terminal
│  │  │  │  ├── scripts
│  │  │  │  │  ├── get_serial_ports.py
│  │  │  │  │  ├── linux_terminator_config
│  │  │  │  │  ├── open_putty.py
│  │  │  │  │  │ open_terminator.py
│  │  │  │  │ uart_terminal.py
doc
│  ├── nrf
│  │  ├── releases_and_maturity
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst

Outputs:

Toolchain

Version: 4aa3467a6d
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:4aa3467a6d_776d264d2e

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain - Skipped: existing toolchain is used
  • ✅ Build twister
    • sdk-nrf test count: 10
  • ✅ Integration tests
    • ✅ test-sdk-audio
Disabled integration tests
    • test-fw-nrfconnect-nrf_lrcs_mosh
    • test-fw-nrfconnect-nrf_lrcs_positioning
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_cloud
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-ps-main
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread-main
    • test-low-level
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

Copy link

github-actions bot commented Jun 5, 2025

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-22660/nrf/releases_and_maturity/releases/release-notes-changelog.html

@koffes koffes requested a review from Copilot June 5, 2025 12:05
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request removes the custom uart_terminal tool from the nRF5340 Audio application, as the functionality is now provided by the VS Code Serial Terminal.

  • Updated the release notes to document the removal of the uart_terminal tool.
  • Removed the uart_terminal.py file and all associated scripts (open_terminator.py, open_putty.py, linux_terminator_config, get_serial_ports.py).

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst Added a changelog entry documenting the tool’s removal.
applications/nrf5340_audio/tools/uart_terminal/uart_terminal.py Removed the main uart terminal script.
applications/nrf5340_audio/tools/uart_terminal/scripts/open_terminator.py Removed the linux-specific terminator launcher.
applications/nrf5340_audio/tools/uart_terminal/scripts/open_putty.py Removed the Windows-specific tool launcher.
applications/nrf5340_audio/tools/uart_terminal/scripts/linux_terminator_config Removed the terminator configuration file.
applications/nrf5340_audio/tools/uart_terminal/scripts/get_serial_ports.py Removed the utility script for retrieving serial ports.
Comments suppressed due to low confidence (1)

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst:221

  • Ensure that the naming for the VS Code tool is consistent across all project documentation. Consider verifying that 'nRF Serial Terminal in VS Code' matches the official naming used elsewhere.
  * The uart_terminal tool. This was custom for audio and we want to converge on standardized tools. Similar functionality is provided via the nRF Serial Terminal in VS Code.

Comment on lines 220 to 221
* Removed:
* The uart_terminal tool. This was custom for audio and we want to converge on standardized tools. Similar functionality is provided via the nRF Serial Terminal in VS Code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Removed:
* The uart_terminal tool. This was custom for audio and we want to converge on standardized tools. Similar functionality is provided via the nRF Serial Terminal in VS Code.
* Removed:
* The uart_terminal tool to use standardized tools.
Similar functionality is provided through the `nRF Terminal <nRF Terminal documentation_>`_ in the |nRFVSC|.

Rephrased the sentence. Please check.

@koffes koffes force-pushed the OCT-3390-remove-uart-terminal-from-ncs branch 2 times, most recently from 01c1d48 to c0b1187 Compare June 13, 2025 11:47
OCT-3390
UART terminal removed to align on standard tools.
Similar functionality is provided via Serial Terminal in VS Code

Signed-off-by: Kristoffer Skøien <kristoffer.skoien@nordicsemi.no>
@koffes koffes force-pushed the OCT-3390-remove-uart-terminal-from-ncs branch from c0b1187 to 2d88f5a Compare June 18, 2025 07:28
@koffes koffes merged commit 3f99f70 into nrfconnect:main Jun 18, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants